docs: Improve grammar/wording for `cargo owner`
authorChes Martin <ches@whiskeyandgrits.net>
Sat, 28 Feb 2015 16:57:42 +0000 (11:57 -0500)
committerChes Martin <ches@whiskeyandgrits.net>
Sat, 28 Feb 2015 16:57:42 +0000 (11:57 -0500)
src/doc/config.md
src/doc/crates-io.md

index d575d7078b689d577e5873f8ee1cd660dec4813f..8a2bf0b7bf8137206d21c8902bbcdf10de6d38b7 100644 (file)
@@ -23,10 +23,12 @@ with a configuration file in your home directory.
 
 # Configuration Format
 
-All configuration is currently in the TOML format (like the manifest), with
-simple key-value pairs inside of sections (tables) which all get merged
+All configuration is currently in the [TOML format][toml] (like the manifest),
+with simple key-value pairs inside of sections (tables) which all get merged
 together.
 
+[toml]: https://github.com/toml-lang/toml
+
 # Configuration keys
 
 All of the following keys are optional, and their defaults are listed as their
index 0128a79ad9f0c300c7160b3a6c675796e7a3a67f..e3b305f8bc015ea8ad62ae1e841a66152c165b82 100644 (file)
@@ -174,9 +174,9 @@ Be sure to check out the [metadata you can
 specify](manifest.html#package-metadata) to ensure your crate can be discovered
 more easily!
 
-## Limitations
+## Restrictions
 
-There are a few limitations when publish a crate in the registry:
+There are a few restrictions when publishing a crate in the registry:
 
 * Once a version is uploaded, it can never be overwritten. To upload a new copy
   of a crate you must upload a new version.
@@ -192,19 +192,19 @@ to manage a crate.
 
 ## `cargo owner`
 
-A crate is often not developed by only one person, or perhaps the main developer
-changes over time! The owners of a crate is the only person allowed to publish
-new versions of the crate, but owners may also add other owners! This subcommand
-allows you to allow others to publish new versions as well as add new owners
-themselves:
+A crate is often developed by more than one person, or the primary maintainer
+may change over time! The owner of a crate is the only person allowed to publish
+new versions of the crate, but an owner may designate additional owners. Using
+this subcommand, an owner allows others to publish new versions, as well as to
+manage the list of owners themselves:
 
 ```notrust
 $ cargo owner --add my-buddy
 $ cargo owner --remove my-buddy
 ```
 
-The logins specified are the GitHub logins used by the user in question. The
-owner being added must also already have logged into crates.io previously.
+The owner IDs given to these commands must be GitHub user names. In order to be
+added, an owner must have also logged into crates.io previously.
 
 ## `cargo yank`